home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 22 / Cream of the Crop 22.iso / os2 / wptool19.zip / checkini.txt < prev    next >
Text File  |  1996-09-22  |  22KB  |  545 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                                                       CHECKINI.TXT - Page 1
  8.           _________________          TABLE OF CONTENTS
  9.  
  10.  
  11.  
  12.           1. DISCLAIMER...................................................1
  13.  
  14.  
  15.           2. IMPORTANT - READ THIS FIRST !................................2
  16.  
  17.  
  18.           3. DESCRIPTION..................................................3
  19.  
  20.           3.1 GENERAL.....................................................3
  21.           3.2 PM_WORKPLACE:HANDLES........................................3
  22.           3.3 ORPHAN OBJECTS..............................................4
  23.  
  24.           4. USING CHECKINI...............................................5
  25.  
  26.  
  27.           5. HOW THE PROGRAM WORKS........................................5
  28.  
  29.  
  30.           6. EXAMPLES OF OUTPUT:..........................................6
  31.  
  32.  
  33.           7. REVISION HISTORY.............................................8
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.                                                       CHECKINI.TXT - Page 2
  41.  
  42.           1. DISCLAIMER
  43.  
  44.  
  45.           I allow you to use and distribute CHECKINI freely under the
  46.           condition that I am in no way responsible for any damage or loss
  47.           you may suffer.
  48.  
  49.           Henk Kelder
  50.           Dennenlaan 12
  51.           3843 BX Harderwijk
  52.  
  53.  
  54.  
  55.           2. IMPORTANT - READ THIS FIRST !
  56.  
  57.           You should take care when using this program on new version of
  58.           OS/2 since this program interprets data from the ini-files.
  59.           The internal structure of this data can change, and the program
  60.           might fail or even corrupt information
  61.           This was the case with the OS/2 2.00.1 (or 2.01) version.
  62.  
  63.  
  64.           CHECKINI checks for, and optionally corrects, some problems in
  65.           OS2.INI and OS2SYS.INI. CHECKINI only looks at information
  66.           regarding the workplace shell.
  67.           The make full use of CHECKINI read this document to require
  68.           information about what CHECKINI does.
  69.  
  70.  
  71.  
  72.  
  73.  
  74.                                                       CHECKINI.TXT - Page 3
  75.  
  76.           3. DESCRIPTION
  77.  
  78.           3.1 GENERAL
  79.  
  80.           The main reason for CHECKINI is the growth that the both .INI
  81.           files tend to have if one uses the Workplace shell heavelly.
  82.           Using CHECKINI in conjunction with COPYINI helps to reduce the
  83.           INI files sizes, which in turn should increase the workplace
  84.           shells performance.
  85.  
  86.           Also CHECKINI helps to determine some possible cause's for
  87.           workplace shell failures like loosing workplace shell objects, or
  88.           situations in which a program object looses the proper executable
  89.           name or current directory. Obviously, the real cause for these
  90.           problems must be in the workplace shell
  91.           itself, CHECKINI however could help you to determine the degree
  92.           of damage that has been done.
  93.  
  94.  
  95.           3.2 PM_Workplace:Handles
  96.  
  97.           A special note is in place about a specific piece of information
  98.           in the INI-files called 'PM_Workplace:Handles'. The workplace
  99.           shell uses some obscure entity called object-handles to refer to
  100.           objects. Object handles are infact numbers. A object-handle can
  101.           refer to a abstract object (a object NOT on your harddisk e.g.
  102.           the color palette) and  file-system objects (files &
  103.           directories).
  104.  
  105.           Abstract objects reside in the ini-files.
  106.           File-system objects reside on your harddisk.
  107.  
  108.           Whenever you add a program object to your desktop and specify a
  109.           programfile the workplace shell determines if a handle was
  110.           already assigned to the programfile and if so, it uses this
  111.           handle. If no handle was assigned, the shell creates a handle and
  112.           assignes it to the programfile. In the definition of the program
  113.           object (self an abstract object) the handle for the programfile
  114.           is stored.
  115.  
  116.           When you start the program by clicking on the object the wps must
  117.           have a way to refer the stored handle back to the programfile.
  118.           This is done by using the 'PM_Workplace:Handles' information.
  119.           Unfortunately only handles are added to this information and they
  120.           are not removed when a (program)file is removed from your
  121.           harddisk.
  122.  
  123.           In theory the total amount of handle-to-file information could
  124.           grow to big and than without any warning you will loose
  125.           information. The workplace shell than shows nonsence or nothing
  126.           at all in some of your program objects.
  127.  
  128.  
  129.  
  130.  
  131.  
  132.                                                       CHECKINI.TXT - Page 4
  133.           CHECKINI allows you to remove handles for files or directories
  134.           that are no longer present or inaccessable.
  135.  
  136.  
  137.           If you have installed the october service pack (CSD Level
  138.           XR06055) there has been a minor change in mechanisme described
  139.           above. The workplace shell now keeps multiple versions of
  140.           'PM_Workplace:Handles' in the ini-files. Appearantly this is
  141.           intended as a error-recovery mechanism. However, I've been unable
  142.           to determine of the backup mechanism itself is implemented.
  143.  
  144.  
  145.           3.3 ORPHAN OBJECTS
  146.  
  147.           An wide spread way to remove undeleteable objects is to move them
  148.           to a directory, and then, in a OS/2 or DOS session remove the
  149.           directory. The Workplace shell than no longer shows the objects.
  150.           They are infact NOT removed but they simply have no parent
  151.           directory to they will show in.
  152.           Also, sometimes it is possible that suddenly several objects are
  153.           lost. A reason for this could be a unintentional removal of a
  154.           desktop directory.
  155.  
  156.           CHECKINI detect these 'orphan objects' and queries to user (when
  157.           /C specified) to move these objects to another (new) location.
  158.           The moved objects will appear after the workplace shell has been
  159.           restarted.
  160.           If this question is answered with NO, another question is asked
  161.           whether the objects should be removed from the ini-files.
  162.  
  163.  
  164.           WARNING 1
  165.  
  166.           if you are normally connected to a network and run CHECKINI when
  167.           you are NOT connected to this network, or when you are not logged
  168.           in, CHECKINI will report errors for references to network
  169.           objects.
  170.           In the situation mentioned above and with the /C swith given,
  171.           take care when confirming deleting or correcting problems.
  172.  
  173.           WARNING 2
  174.  
  175.           Whenever you run CHECKINI with the /C switch you must be prepared
  176.           to shutdown immidiatly after you have run the program. This
  177.           because the workplace shell has a lot of info in memory and it
  178.           you keep on working some of the changes checkini has made will be
  179.           overwritten by the desktop.
  180.  
  181.  
  182.  
  183.  
  184.  
  185.                                                       CHECKINI.TXT - Page 5
  186.  
  187.           4. USING CHECKINI
  188.  
  189.           From an OS/2 command prompt enter the command CHECKINI. Without
  190.           any command line options CHECKINI doesn't change anything to your
  191.           ini-files.
  192.  
  193.           COMMAND LINE OPTIONS
  194.  
  195.           /C   -      Write corrections to ini-files. The default is to
  196.                       diagnose only. If this option is specified the
  197.                       program will ask confirmations for all changes it
  198.                       may want to do in your   ini-files.
  199.  
  200.           /Apath    - Specify different location for ini-files to be
  201.                       checked. This option is usefull if you have a copy
  202.                       of you ini files and you would like these copies to
  203.                       be checked.
  204.                       NOTE: Do NOT use this option to check ini-files not
  205.                       belonging to the PC you run CHECKINI on.
  206.  
  207.           /Llogfilename- Specify name of logfile. The default is
  208.                       CHECKINI.LOG in the directory you start the program
  209.                       in.
  210.  
  211.           /W   -      Write all output to logfile. Normally only problems
  212.                       are written to the logfile. This option could help
  213.                       you to inspect a lot about your workplace shell
  214.                       objects (actually workplace shell objects
  215.                       instances).
  216.  
  217.           /S   -      'Silent run', only write logfile. Normally found
  218.                       errors are reported directly.
  219.  
  220.           /R  -       Do not report errors on files on network drives or
  221.                       removable local drives like diskette's or CD-roms.
  222.  
  223.           /?   -      Show info.
  224.  
  225.  
  226.  
  227.  
  228.           5. HOW THE PROGRAM WORKS
  229.  
  230.           While running CHECKINI displays all found information on the
  231.           screen. Whenever a problem is found, and the /S switch is not
  232.           used the program reports the problem. The problem itself is
  233.           visible in the bottom lines of the screen. Problems are always
  234.           reported in CAPITALS.
  235.  
  236.  
  237.  
  238.  
  239.  
  240.                                                       CHECKINI.TXT - Page 6
  241.  
  242.           6. EXAMPLES of OUTPUT:
  243.  
  244.           =================================================
  245.            PM_Workplace:Handles:BLOCK1                  
  246.           =================================================
  247.           3E2DA:CHECKINI.EXE   =>E:\ICON\CHECKINI.EXE<-UNABLE TO ACCESS
  248.           395F8:COPYINI.EXE    =>E:\ICON\COPYINI.EXE<-UNABLE TO ACCESS
  249.           39400:GETPROG.EXE    =>E:\ICON\GETPROG.EXE<-UNABLE TO ACCESS
  250.           =================================================
  251.            PM_Abstract:Objects & PM_Abstract:FldrContents
  252.           =================================================
  253.             Object 13087, Class WPNetLink : A network folder
  254.              Linked to: \\SERVER09\SYS3\DIRECTORY1<-UNABLE TO ACCESS!
  255.             Object 140AD, Class WPNetLink : SYS3
  256.              Linked to: \\SERVER09\SYS3<-UNABLE TO ACCESS!
  257.             Object 15185, Class WPNetLink : SYS1
  258.              Linked to: \\SERVER09\SYS1<-UNABLE TO ACCESS!
  259.             Object 15956, Class WPNetLink : A network folder
  260.              Linked to: \\SERVER09\SYS3\DIRECTORY1<-UNABLE TO ACCESS!
  261.           =================================================
  262.            Checking AssocCheckSum                         
  263.           =================================================
  264.           PMWP_ASSOC_CHECKSUM:252153
  265.             points to 3D8F9 - E:\ICON\GETBLOCK.EXE<-UNABLE TO ACCESS
  266.           =================================================
  267.            Checking FolderPos                             
  268.           =================================================
  269.           PM_Workplace:FolderPos:252223@10
  270.             points to 3D93F - OBJECT DOES NOT EXIST
  271.  
  272.  
  273.  
  274.  
  275.  
  276.                                                       CHECKINI.TXT - Page 7
  277.           WHAT THE PROGRAM CHECKS
  278.  
  279.           The following ini-records (Application - Key) are checked:
  280.  
  281.           PM_Workplace:Handles    - BLOCK1
  282.           (Checks consistency and existence of filesystem object-handles)
  283.  
  284.           PM_Workplace:Location   - (all keys)
  285.           (Checks existence of object where id-strings like <WP_DESKTOP>
  286.           point to)
  287.  
  288.           PM_Workplace:Folderpos  - (all keys)
  289.           (Checks for obsolete saved object positions)
  290.  
  291.           PM_PrintObject:JobCnrPos - (all keys)
  292.           (Checks for obsolete saved print job container positions)
  293.  
  294.           PM_Workplace:PalettePos - (all keys)
  295.           (Checks for obsolete saved palette positions)
  296.  
  297.           PM_Workplace:Templates  - (all keys)
  298.           (Checks for template-records that refer to non-existing objects)
  299.  
  300.           PM_Abstract:Objects     - (all keys)
  301.           (Mainly checks WPProgram objects for consistency, but also checks
  302.           for 'lost-objects' - objects moved to non-existing locations.
  303.           Also checks WPNetLink and WPShadow links.)
  304.  
  305.           PM_Abstract:FldrContent - (all keys)
  306.           (Used for the check mentioned above for 'lost-objects')   
  307.  
  308.           PM_Abstract:Icons       - (all keys)
  309.           (Checks for obsolete icons, icons for abstract objects that do
  310.           not exist)
  311.  
  312.           PMWP_ASSOC_FILTER       - (all keys)
  313.           (Checks for associations with non-existing objects)
  314.  
  315.           PMWP_ASSOC_TYPE         - (all keys)
  316.           (Checks for associations with non-existing objects)
  317.  
  318.           PMWP_ASSOC_CHECKSUM     - (all keys)
  319.           (Checks for obsolete checksum record that point to non-existing
  320.           objects)
  321.  
  322.           PM_Workplace:Location   - (all keys)
  323.           (Checks consistency of logical location names e.g. <WP_DESKTOP>)
  324.  
  325.           PM_Workplace:Startup    - (all keys)
  326.           (Checks if the referenced folders are infact startup folders)
  327.  
  328.           FolderWorkareaRunningObjects - (all keys)
  329.           (Checks for a list of open objects for a workarea)
  330.  
  331.  
  332.  
  333.  
  334.  
  335.                                                       CHECKINI.TXT - Page 8
  336.  
  337.           7. REVISION HISTORY
  338.  
  339.           Notes on version 1.1:
  340.  
  341.           Some checks were added:
  342.           - PM_Workplace:PalettePos
  343.           - PM_Workplace:Startup
  344.           - Some other checkings were extended.
  345.  
  346.           Notes on version 1.2:
  347.  
  348.           - The check for PM_Workplace:Handles was moved so that it would
  349.             be the last test done.
  350.           - The frase 'DOES NOT EXIST' for file objects (files &
  351.             directories) has been changed to 'UNABLE TO ACCESS' since this
  352.             is a beter description of what CHECKINI finds.
  353.  
  354.           Notes on version 1.3:
  355.  
  356.           - The only extra in this version is that it support OS/2 2.00.1
  357.             (beta version) since in this version the internal structure of
  358.             various workplace shells object data has changed.
  359.  
  360.           Notes on version 1.4:
  361.  
  362.           - Not all of the data checkini appearantly needs to exist. If
  363.             some data checkini checks does not exist, the test is skipped.
  364.  
  365.           Notes on version 1.5:
  366.  
  367.           Checkini now works properly after installing the servicepack
  368.           dated october 1992.
  369.  
  370.           Notes on version 1.6:
  371.  
  372.           - Two additional tests were added. These test are for:
  373.                - 'FolderWorkareaRunningObjects' and
  374.                - 'PM_PrintObject:JobCnrPos'
  375.  
  376.           - When a conflict in OBJECTID's is detected (two or more objects
  377.             having the same OBJECTID, CHECKINI /c can assign a new OBJECTID
  378.             to the objects that claim to have an OBJECTID that is already
  379.             in use by another object.
  380.  
  381.           - Updated the documentation files (this file)
  382.  
  383.           A simple test has been build in to see if OBJECTID's can be found
  384.           in the ini-files, to determine if the internal data structure of
  385.           the ini-files might have been changed and CHECKINI will fail
  386.           completely. This is however no guarantee that CHECKINI will
  387.           function properly on new versions of OS/2.
  388.  
  389.  
  390.  
  391.  
  392.  
  393.                                                       CHECKINI.TXT - Page 9
  394.  
  395.           Notes on version 1.7:
  396.  
  397.           - The 'simple test' mentioned above might block someone using
  398.             CheckIni if the ini-file itself is corrupt. Now the test is
  399.             only performed when /C (correct) switch is specified.
  400.  
  401.           Notes on version 1.8:
  402.  
  403.           - When checking 'PM_Workplace:Handles' a test has been put in   
  404.             that checks the accessibility on a volume in one strike. If the
  405.             user okays the removal of all references to a non-locateable
  406.             volume, all handles on that volume are removed without further
  407.             checking.
  408.  
  409.           Notes on version 1.81:
  410.  
  411.           - Apparently CheckIni went bananas whenever an alternate ini
  412.             directory was specified and no ini's were found. This has been
  413.             corrected.
  414.           - Some minor enhancements were made to the text that is being
  415.             shown on the screen. These changes mainly have to do with
  416.             signalling problems with OBJECTID's.
  417.           - CheckIni refused to Change/Correct anything if the Desktop's
  418.             Extended attributes have been damaged. CheckIni now offers a
  419.             try-to-repair option. This option comes down to CheckIni re-
  420.             assigning objectid <WP_DESKTOP> to the desktop when CheckIni is
  421.             unable to locate this ObjectId inside the Desktop Extended
  422.             Attributes. If this corrective action has been taken CheckIni
  423.             terminates and one should wait a view moments so the WPS has
  424.             time to update the physical extended attribute on disk.
  425.  
  426.           Notes on version 1.90:
  427.  
  428.           - This version now supports all known versions of OS/2 2.0 and
  429.             OS/2 2.1 Beta versions up till release level 6.498 (March '93)
  430.  
  431.           Notes on version 1.91:
  432.  
  433.           - The try-to-repair option will be called also now when the
  434.             desktop folder doesn't contain the .CLASSINFO extended 
  435.             attribute at all.
  436.  
  437.           - When /C was specified, and lost objects were found and the user
  438.             choose for 'discard object', the OBJECTID was still checked and
  439.             when an error was found the program asked if a new OBJECTID
  440.             should be assigned. This has been corrected.
  441.  
  442.           Notes on version 1.92:
  443.  
  444.           - Several small (non-functional) errors were corrected.
  445.           - Verified that CHECKINI works with OS/2 2.1 GA (rev. 6.514)
  446.  
  447.  
  448.  
  449.  
  450.  
  451.                                                      CHECKINI.TXT - Page 10
  452.           Notes on version 1.93:
  453.  
  454.           - Corrected a problem were CheckIni reported a problem with 'Not
  455.             enough memory' in GetAllProfileNames.
  456.  
  457.           - When a directory containing objects is missing, CHECKINI now
  458.             first tries to recreate this directory before trying to move
  459.             the objects. (Only on local drives)
  460.  
  461.           Notes on version 1.94:
  462.  
  463.           - Due to a bug in the Workplace shell, whenever Checkini
  464.             (re)assigned an OBJECTID to a Scheme Palette, all scheme's went
  465.             to 'New Scheme'.
  466.  
  467.           - The same problem  could occur on OS/2 2.1 installations that
  468.             were installed on top of OS/2 2.0. The problem would even then
  469.             occur when the /C option was not specified. These problems have
  470.             been corrected.
  471.  
  472.           Notes on version 1.95:
  473.  
  474.           - When the workplace shell had more then 64 Kb of object-handle-
  475.             to-file data (PM_Workplace:HandlesX) CHECKINI would mess up.
  476.             Now CHECKINI can handle multiple BLOCK records and will only
  477.             write as much of these records as needed back to OS2SYS.INI
  478.             (and discard any others)
  479.  
  480.           - Objects of class WPTransient were not recognized and therefore
  481.             whenever and OBJECTID of such an object existed CHECKINI would
  482.             give an error message. This has been corrected.
  483.  
  484.           Notes on version 1.96:
  485.  
  486.           1. 
  487.             Checkini with abort when very long file names had to be
  488.             presented on the screen. This has been corrected.
  489.  
  490.           Notes on version 1.97:
  491.  
  492.           - This version works with OS/2 3.0 (Warp version)
  493.           - Some minor bugs where corrected.
  494.  
  495.           Notes on version 1.98:
  496.  
  497.           - In version 1.95 I added logic to handle more then 64 Kb of
  498.             object-handle-to-file data. I implicitally assumed then that I
  499.             would always read the multiple BLOCK records in the proper
  500.             order. As it turns out this assumption is not always correct.
  501.             I've changed it so I will always read the proper order.
  502.  
  503.           Notes on version 1.99:
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.                                                      CHECKINI.TXT - Page 11
  511.           I've found that some OBJECTID's can be *extreme* long. I've
  512.           increased the internal buffer from 50 to 150 chars.
  513.  
  514.           Notes on version 1.991
  515.  
  516.           - Corrected some problems with corrupted objectdata where
  517.             checkini would trap on.
  518.           - Implemented the /R switch that makes Checkini to ignore errors
  519.             on non-locateable drives.
  520.           - Added tests for object classes, PM_Workplace:StatusPos, and
  521.             PM_PrintObjects. Also checkini now tests all abstract objects
  522.             for existing classes and checks if startup folders are present
  523.             in PM_Workplace:Startup.
  524.           - CHECKINI now offers to remove objects that contain errors (/C
  525.             option only).
  526.  
  527.           Notes on version 2.000
  528.  
  529.           For a long time I did not release new versions. This had to do
  530.           with a burglary at my house where, amongst other things, I lost
  531.           my PC and thus my fidonet connection.
  532.  
  533.           - Changed the way object classes are checked. Before trying to
  534.             load a Dynamic link library containing a specific class I first
  535.             check if the dll has already been loaded. Also some specific
  536.             classes are not checked since they always gave troubles.
  537.           - Increased several internal buffers to accomodate the changes in
  538.             Warp 3.0, FP 17 and above and the current gamma version of
  539.             merlin. I did not make any specific functional changes for
  540.             merlin.
  541.           - Changed the way the /R parameter works. Now /R means: Only
  542.             check for files on local, non-removable disks. This implies
  543.             that local diskette or CD-rom drives are not checked when this
  544.             option is specified.
  545.